Routines (alphabetical) > Routines: H > HDF-EOS Routines > EOS_GD_DEFPIXREG

EOS_GD_DEFPIXREG

This function defines whether the pixel center or pixel corner (as defined by the EOS_GD_DEFORIGIN function) is used when requesting the location (longitude and latitude) of a given pixel.

Syntax

Result = EOS_GD_DEFPIXREG(gridID, pixreg)

Return Value

Returns SUCCEED(0) if successful and FAIL(–1) otherwise.

Arguments

gridID

Grid id (long) returned by EOS_GD_CREATE or EOS_GD_ATTACH.

pixreg

Pixel registration (long). The allowable values are:

0 = Center
1 = Corner

Keywords

None

Examples

In this example, we define the pixel registration to be the corner of the pixel cell:

status = EOS_GD_DEFPIXREG(gridID, 1)

Version History

5.2	Introduced